Get Group
AutomatR.AWS.Activities.GetGroup
The "Get Group" activity in AutomatR is part of the AWS IAM (Identity and Access Management) activities package, enabling automation processes to retrieve information about a specified IAM group. This activity streamlines the process of obtaining details related to IAM groups, enhancing the efficiency of automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Access Key ID | Provides the encrypted access key ID for your AWS account, enabling connection to the AWS IAM service. String variables containing the access key ID. |
| Secret Access Key | Provides the encrypted secret access key for your AWS account, enabling connection to the AWS IAM service. String variables containing the secret access key. |
| Region | Specifies the desired AWS region in which the IAM group is located. Use the RegionEndpoint enumeration to set the region. |
| Name | Specifies the name of the IAM group for which information should be retrieved. String variables containing the group name. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variable or argument containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Get Group" activity. Useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the wait time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Group | Obtains information about an IAM group and stores the result in a GetGroupResponse variable format for further processing. Variables of type GetGroupResponse to store the details of the IAM group. |
How to use:
- Drag and drop the "Get Group" activity onto the workflow.
- Configure the properties by providing the required inputs, such as access key ID, secret access key, region, and IAM group name.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to retrieve information about the specified IAM group.
Example: Consider an example where the "Get Group" activity is used to retrieve information about an IAM group named "ExampleGroup" in the "us-east-1" region:
Get Group:
Display Name: "Retrieve IAM Group Info"
Access Key ID: "**************"
Secret Access Key: "**************"
Region: "us-east-1"
Name: "ExampleGroup"
Group: iamGroupInfo
In this example, the activity retrieves information about the IAM group named "ExampleGroup" in the "us-east-1" region. The result is stored in the variable "iamGroupInfo" of type GetGroupResponse for further handling in the workflow.